singleselection: Clarify docs
authorMatthias Clasen <mclasen@redhat.com>
Sat, 6 Jun 2020 15:53:33 +0000 (11:53 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 6 Jun 2020 15:53:33 +0000 (11:53 -0400)
Mention persistence and sorting.

gtk/gtksingleselection.c

index 63db37d0de5fdc513ec25123716939e670cf5b78..5d0172c7b1561b8f4ea8b3167cc83c7679f6a9f4 100644 (file)
  * @Title: GtkSingleSelection
  * @see_also: #GtkSelectionModel
  *
- * GtkSingleSelection is an implementation of the #GtkSelectionModel interface 
+ * GtkSingleSelection is an implementation of the #GtkSelectionModel interface
  * that allows selecting a single element. It is the default selection method
  * used by list widgets in GTK.
+ *
+ * Note that the selection is *persistent* -- if the selected item is removed
+ * and re-added in the same ::items-changed emission, it stays selected. In
+ * particular, this means that changing the sort order of an underlying sort
+ * model will preserve the selection.
  */
 struct _GtkSingleSelection
 {